Skip to content

Fix Doxygen @param entries in /include - #21762

Merged
rapids-bot[bot] merged 6 commits into
NVIDIA:mainfrom
vuule:docs-param-fixes-include
Mar 16, 2026
Merged

Fix Doxygen @param entries in /include#21762
rapids-bot[bot] merged 6 commits into
NVIDIA:mainfrom
vuule:docs-param-fixes-include

Conversation

@vuule

@vuule vuule commented Mar 12, 2026

Copy link
Copy Markdown
Contributor

Description

AI-assisted, human-verified, fixes for the Doxygen parameter documentation - limited to /include directory.

We often find these kinds of errors in new PRs. With AI code review we will probably stop merging new errors of this type. This PR aims to fix old error so we hopefully stay 100% accurate from now on.

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@copy-pr-bot

copy-pr-bot Bot commented Mar 12, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions github-actions Bot added the libcudf Affects libcudf (C++/CUDA) code. label Mar 12, 2026
@vuule vuule added doc Documentation improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Mar 12, 2026
@vuule vuule removed the improvement Improvement / enhancement to an existing function label Mar 12, 2026
@vuule

vuule commented Mar 12, 2026

Copy link
Copy Markdown
Contributor Author

/ok to test d01d060

@davidwendt

Copy link
Copy Markdown
Contributor

This looks good.
Just wanted to note here for reviewers that these are all detail declarations so they don't appear in our public docs.
Also, noticing that the bit.hpp header declares only detail functions but is not in a detail folder.

@vuule
vuule marked this pull request as ready for review March 12, 2026 18:09
@vuule
vuule requested a review from a team as a code owner March 12, 2026 18:09
@vuule
vuule requested review from bdice and shrshi March 12, 2026 18:09
*
* @param p A \c pointer to the previously allocated memory.
* @note The second parameter is the number of objects previously allocated.
* @param cnt Number of objects that werepreviously allocated.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing a space in this sentence. I also wish this was count...

Suggested change
* @param cnt Number of objects that werepreviously allocated.
* @param cnt Number of objects that were previously allocated.

@vuule

vuule commented Mar 16, 2026

Copy link
Copy Markdown
Contributor Author

/ok to test 0e2c513

@vuule vuule added the 5 - Ready to Merge Testing and reviews complete, ready to merge label Mar 16, 2026
@vuule

vuule commented Mar 16, 2026

Copy link
Copy Markdown
Contributor Author

/merge

@rapids-bot
rapids-bot Bot merged commit cfa6ef1 into NVIDIA:main Mar 16, 2026
117 checks passed
@vuule
vuule deleted the docs-param-fixes-include branch March 16, 2026 20:35
rapids-bot Bot pushed a commit that referenced this pull request Aug 12, 2026
…ns (#23564)

Doxygen tags in `cpp/include` and `cpp/src` that name something the declaration below them does not have. Comments only — no code, no behaviour, no tests.

**`@tparam` with the name missing** — `column_view_base::head` and `mutable_column_view::head` both carry `@tparam The type to cast to`, so Doxygen takes `The` as the template parameter name and `T` goes undocumented.

**`@tparam` left over from a refactor** — eight of the `make_device_uvector*` overloads in `detail/utilities/vector_factories.hpp` document both `Container` and `T`, but those overloads are `template <typename Container>` only. The `T` line is a leftover from the `host_span<T>` overloads above them.

**`@tparam` renamed** — `id_to_type` documents `t` while the parameter is `Id`; `dictionary_column_wrapper` documents `SourceElementTo` while the parameter is `SourceElementT`.

**`@param` on a function that takes nothing** — `arrow_column::view()` and `arrow_table::view()` document `stream` and `mr`, copied from the `to_arrow` overload directly above each. Both take no arguments.

**`@param` where `@tparam` was meant** — `is_boolean()` documents `@param type The data_type to verify` and `is_nested()` documents `@param T`; both are `template <typename T>` predicates with no runtime arguments.

A second commit covers the further files pointed out in review: `column_device_view_base.cuh`, `type_dispatcher.hpp`'s `IdTypeMap`, `iterator.cuh`, `timestamp_utilities.cuh`, `rolling/detail/range_utils.cuh` and `strings/count_matches.hpp`.

Follows #21762 and #21764, which did the same for other entries in `/include` and `/src`. Every tag here was opened and read against the declaration underneath it.

Authors:
  - Dmitry (https://github.com/darkdi)
  - Igor Peshansky (https://github.com/igorpeshansky)
  - Nghia Truong (https://github.com/ttnghia)

Approvers:
  - Igor Peshansky (https://github.com/igorpeshansky)
  - Nghia Truong (https://github.com/ttnghia)
  - Yunsong Wang (https://github.com/PointKernel)

URL: #23564
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5 - Ready to Merge Testing and reviews complete, ready to merge doc Documentation libcudf Affects libcudf (C++/CUDA) code. non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants